FoldersApi

Functions

addDocumentsToFolder

@PUT(value = folders/{folderId}/documents)

abstract suspend fun addDocumentsToFolder(@Path(value = folderId) folderId: String, @Body() addOrRemoveDocumentsFromFolderDto: AddOrRemoveDocumentsFromFolderDto): Response<DocumentsAddedOrRemovedFromFolderResponseDto>

Add document(s) to folder This endpoint allows you to add one or more documents to a folder owned by the user Responses:

200: Success. Documents were successfully added to folder
401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.
404: Not Found. The folderID or one of the receipt IDs you have provided do not exist or do not belong to the user.

createFolder

@POST(value = folders)

abstract suspend fun createFolder(@Body() folderCreateRequestDto: FolderCreateRequestDto): Response<FolderCreationResponseDto>

Add a new folder for a user This endpoint allows you to add a folder to the authenticating user's account.

deleteFolder

@DELETE(value = folders/{folderId})

abstract suspend fun deleteFolder(@Path(value = folderId) folderId: String, @Query(value = deleteDocuments) deleteDocuments: Boolean? = false, @Body() folderDeleteRequestDto: FolderDeleteRequestDto? = null): Response<EmptyObjectResponseDto>

Delete a folder for a user This endpoint allows you to delete a folder from the authenticating user's account.

deleteFolders

@DELETE(value = folders)

abstract suspend fun deleteFolders(@Query(value = folders) folders: String, @Query(value = deleteDocuments) deleteDocuments: Boolean? = false, @Body() foldersDeleteRequestDto: FoldersDeleteRequestDto? = null): Response<EmptyObjectResponseDto>

Delete multiple folders for a user This endpoint allows you to perform a batch deletion of folders on a User object.

getFolders

@GET(value = folders)

abstract suspend fun getFolders(@Query(value = locale) locale: String? = null): Response<GetFoldersListResponseDto>

List the folders for a user This endpoint allows you to list the folders in the authenticating user's account.

removeDocumentFromFolder

@DELETE(value = folders/{folderId}/documents)

abstract suspend fun removeDocumentFromFolder(@Path(value = folderId) folderId: String, @Body() addOrRemoveDocumentsFromFolderDto: AddOrRemoveDocumentsFromFolderDto): Response<DocumentsAddedOrRemovedFromFolderResponseDto>

Remove document(s) from folder This endpoint allows you to remove multiple documents from a folder owned by the user Responses:

200: Success. Documents were successfully removed from the folder
401: Unauthorized. This will occur if you do not supply an access-token to this endpoint, or if you provide an expired or invalid access token.
404: Not Found. The folderID or one of the receipt IDs you have provided do not exist or do not belong to the user.

upsertFolder

@PUT(value = folders/{folderId})

abstract suspend fun upsertFolder(@Path(value = folderId) folderId: String, @Body() folderUpdateRequestDto: FolderUpdateRequestDto): Response<EmptyObjectResponseDto>

Update a folder for a user This endpoint allows you to update a folder in the authenticating user's account.